home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-05 / autodc10.zip / AUTODOC.DOC < prev    next >
Text File  |  1993-03-03  |  8KB  |  212 lines
  1. AutoDoc 1.0 03-Mar-1993 - Automatic File Server Documentation
  2. Copyright (c) 1992, 1993 Burkhard Daniel
  3.                      and Hans-Georg Michna.
  4. All rights reserved.
  5.  
  6.  
  7.  
  8. Introduction and Price
  9.  
  10. AutoDoc is a utility program for DOS which scans any disk
  11. directory including all its subdirectories and creates a
  12. documentation text file. This result file can contain,
  13. depending on switches:
  14.  
  15. - a complete listing of all subdirectories,
  16. - for each directory a directory description,
  17. - for each directory a list of files including length, date,
  18.   time and attributes,
  19. - for each text file the text of the file up to a certain
  20.   length.
  21.  
  22. AutoDoc is Shareware. You may download and redistribute it
  23. freely and test it for up to 30 days. After this trial period
  24. the use on disks that can be reached only from one PC, such as
  25. local hard disks, remains free. As soon as the disk or a
  26. directory of it is shared among two or more users, the
  27. computer is considerered a file server. For each file server
  28. computer a shareware fee of $15 has to be paid after the trial
  29. period. Payment has to be done through CompuServe's SWREG. To
  30. pay, log on to CompuServe and enter the command: GO SWREG.
  31. Search for the key: "AUTODOC" and follow the instructions to
  32. register.
  33.  
  34.  
  35.  
  36. Instructions for Use
  37.  
  38. Usage: AUTODOC [startpath [switches]]
  39.  
  40. Command line switches:
  41.  
  42. /?       - Show this help screen
  43. /Oxxxxx  - Output file name (default: "AUTODOC.TXT")
  44. /S       - Include subdirectories (default: off)
  45. /F       - Include files (default: off)
  46. /E       - Names are sorted by extension
  47. /U       - Names remain unsorted
  48. /Bxxxxx  - Maximum line length (default: 80)
  49. /D       - List drive spec  (default: off)
  50. /Ixxxxx  - Directory description file name (default:
  51.            "DIRINFO")
  52. /Lxxxxx  - Bytes up to which a text file is listed in the
  53.            output
  54.            (default: 16384, max: 65534, 0: don't list files)
  55. /X       - Exclude directories, must be followed by a list of
  56.            directories. (default: include all directories)
  57.            Example: /X USER \MACHINE
  58. /Y       - Allows different lengths (see /L) for special
  59.            extensions.
  60.            Must be followed by a list of terms as shown below.
  61.            Example: /Y BAT,SYS,TXT:15000 BAS,C,CPP,PAS:200 INI:0
  62.  
  63.  
  64.  
  65. Detailed explanation of the switches
  66.  
  67. Note that in the following explanation the word: "printed" is
  68. used as an abbreviation for: "written into the output
  69. documentation file". In fact AutoDoc doesn't print anything.
  70. It only writes all of its results into the output text file.
  71.  
  72. /?       - Show this help screen
  73.  
  74. This switch shows the help screen with the short switch
  75. descriptions.
  76.  
  77. /Oxxxxx  - Output file name (default: "AUTODOC.TXT")
  78.  
  79. By default the output file name is created in the directory to
  80. be documented and is named AUTODOC.TXT. With the /O switch
  81. (letter Oh, not digit zero) you can determine a different file
  82. name and also a different directory. Example:
  83.  
  84. AUTODOC \USERDATA /O\USER\JOE\SERVER.TXT
  85.  
  86. /S       - Include subdirectories (default: off)
  87.  
  88. By default AutoDoc will only document the target directory.
  89. With the /S switch the documentation will also include all
  90. subdirectories to any degree of the target directory.
  91.  
  92. /F       - Include files (default: off)
  93.  
  94. With the /F switch AutoDoc will include a listing of files for
  95. each subdirectory. This listing will include the length, date,
  96. time and attributes of each file and a remark. The remark is
  97. "(see below)" for text files whose contents are losted below,
  98. or "(file could not be opened)" for files that could not be
  99. accessed because they were presumably opened for writing by
  100. another program.
  101.  
  102. /E       - Names are sorted by extension
  103.  
  104. The file names of each file listing will be sorted by their
  105. three letter extensions. Default: Files are sorted by name.
  106.  
  107. /U       - Names remain unsorted
  108.  
  109. The file names of each file listing will remain unsorted, i.e.
  110. in their original sequence. Default: Files are sorted by name.
  111.  
  112. /Bxxxxx  - Maximum line length (default: 80)
  113.  
  114. The listings of text files are by default line wrapped such
  115. that no line is longer than 80 characters. With the /B switch
  116. this length can be changed. Example:
  117.  
  118. AUTODOC \ /B65
  119.  
  120. This command will list the contents of all text files, but
  121. will wrap the lines such that no line is longer than 65
  122. characters.
  123.  
  124. /D       - List drive spec  (default: off)
  125.  
  126. Without this switch, subdirectories will be listed beginning
  127. with a backslash (\) in cloumn 1. With the /D switch each
  128. directory will be listed with the driver designation preceding
  129. the directory path. Example of output:
  130.  
  131. F:\PUBLIC\OS2
  132.  
  133. /Ixxxxx  - Directory description file name (default:
  134.            "DIRINFO")
  135.  
  136. AutoDoc will look in each directory for a file named DIRINFO
  137. (no extension). If this file is found, then it is presumed to
  138. contain a textual description of the directory and printed
  139. underneath the directory name.
  140.  
  141. With the /I switch the name of these description files can
  142. globally be changed to another file name. Note that DIRINFO is
  143. also the description name used by the Norton Commander version
  144. 3. It is recommended that you put a DIRINFO text file into
  145. each directory for which you want a description printed.
  146.  
  147. /Lxxxxx  - Bytes up to which a text file is listed in the
  148.            output
  149.            (default: 16384, max: 65534, 0: don't list files)
  150.  
  151. By default all text files, determined as those that do not
  152. contain any special characters 0-8, 11, 14-25 or 27 in their
  153. first part, are listed up to a certain length. This length is
  154. by default 16384 (16 K bytes). You can change this default
  155. text listing length to another one with the /L switch.
  156. Example:
  157.  
  158. AUTODOC \ /S /F /L200
  159.  
  160. This command will list only the first 200 characters of all
  161. text files.
  162.  
  163. /X       - Exclude directories, must be followed by a list of
  164.            directories. (default: include all directories)
  165.            Example: /X USER \MACHINE
  166.  
  167. With this switch subdirectories of a few directories can be
  168. excluded from the listing. Example:
  169.  
  170. AUTODOC F:\ /S /F /X USER MACHINE
  171.  
  172. This command would create a documentation file that includes
  173. all directories and subdirectories. The listing would also
  174. contain full lists of the excluded directories, but no
  175. subdirectories of these would subsequently be listed.
  176.  
  177. /Y       - Allows different lengths (see /L) for special
  178.            extensions.
  179.            Must be followed by a list of terms as shown below.
  180.            Example: /Y BAT,SYS,TXT:15000 BAS,C,CPP,PAS:200 INI:0
  181.  
  182. This switch allows to set different lengths for text file
  183. contents listings, including 0 which suppresses the listing of
  184. files with these extension entirely. In the example above all
  185. text files with the extensions .BAT, .SYS, .TXT would be
  186. listed up to a length of 15000 characters. All text files with
  187. the extensions .BAS, .C, .CPP, .PAS would be listed up to a
  188. length of only 200 characters and text files with an extension
  189. of .INI would not be listed at all. All text files with other
  190. extensions would be listed according to the /L switch or its
  191. default if no /L switch is present.
  192.  
  193.  
  194.  
  195. Usage Hints
  196.  
  197. The result file from AutoDoc can be very long for large file
  198. server disks with many subdirectories. The best way to reduce
  199. the size of the documentation is to use the /L switch with a
  200. much smaller figure than the default 16384 bytes, like /L200
  201. whch will yield only about three lines per text file. To
  202. switch off the listing of text files altogether, use: /L0
  203.  
  204. To structure the result file you can use the outliner feature
  205. of your word processor. In Word for Windows, for example,
  206. replace all: "^p^p\" with the same text: "^p^p\", but with an
  207. outline style attached. (If you use the /D switch on a drive
  208. F:, for example, then use "^p^pF:\" instead. There is some
  209. minimal likelihood that a similar text might appear in the
  210. listing of a text file, which would upset this procedure, but
  211. with the /D switch you can make this yet less likely.
  212.